/*
 * Copyright (c) Tecplot, Inc.
 *
 * All rights reserved.  Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   - Redistributions of source code must retain the above copyright notice, this list of
 *     conditions and the following disclaimer. 
 *   - Redistributions in binary form must reproduce the above copyright notice, this list
 *     of conditions and the following disclaimer in the documentation and/or other
 *     materials provided with the distribution.
 *   - Neither the name of the Tecplot, Inc., nor the names of its contributors may be
 *     used to endorse or promote products derived from this software without specific
 *     prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
 * THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef TECFILE_H_ /* Only include once */
#define TECFILE_H_

#include <string>
#include <vector>
#include <exception>
#include "TECADDON.h"

class TecFile
{
public:
    // public exception class
    class Error : public std::exception
    {
    public:
        Error(const std::string& message);
        ~Error() throw();

        virtual const char* what() throw();
    private:
        std::string m_errorMessage;
    };

    enum DataType
    {
        Float,
        Double
    };

    enum DataFormat
    {
        Block,
        Point
    };

    TecFile(const std::string&              dataSetTitle,
            const std::vector<std::string>& variables,
            const std::string&              fileName,
            const std::string&              scratchDirectory,
            DataType                        dataType);

    void zone(const std::string& name,
              ZoneType_e         zoneType,
              LgIndex_t          numNodes,
              LgIndex_t          numElements,
              DataFormat         dataFormat,
              Strand_t           strandID,
              double             solutionTime);

    void data(const std::vector<float>& dataArray);

    void connectivity(const std::vector<LgIndex_t>& dataArray);

    /**
     * This will be called in the destructor if not called previously, but
     * the exception it may throw will be swallowed in the destructor.
     */
    void close();

    virtual ~TecFile();

private:
    bool   m_isClosed;
    size_t m_numValuesWritten;
};

#endif
